Get List of End Users for Service
This request retrieves a list of M365 users for an existing customer.
| ● | This functionality is only supported for Essentials Plus and Pro services; ensure you have a secure connection for synchronization between Live Platform and Microsoft Teams (see Secure Connection with Customer M365 Tenant Platform). |
| ● | For Hosted Essentials services, users must be managed directly in their Teams admin center. |
URI
{{baseUrl}}/api/v3/customer/{customerGuid}/userHTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
||||||
|---|---|---|---|---|---|---|---|---|
|
customerGuid |
string($uuid) (path) |
umpCustomerGuid' value created in the Live Platformcustomer tenant SQL database directory:
Extract this value using Get Services Brief Details (V3) or Get Customers Brief Details (V2) searching for the matching Short Name of the service. |
||||||
|
Page Number |
integer Default value: 1 |
Page number in range to retrieve. |
||||||
|
Page Size |
integer Default minimum value: 2 maximum: 10000 |
Number of pages in range to retrieve. |
Example Response
{
"currentPage": 1,
"pageSize": 10,
"totalPages": 4,
"totalRecords": 37,
"data": [
{
"Identity": "04b6aa84-eb73-4f46-ba4a-200f86a2563a",
"Status": "----",
"SipAddress": "sip:meganb@m365x33712745.onmicrosoft.com",
"LineURI": null,
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "04B6AA84-EB73-4F46-BA4A-200F86A2563A",
"WebName": "Megan Bowen",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "MeganB@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "0a7db8a7-ef2d-4794-81e1-518fb15770d1",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": null,
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "0A7DB8A7-EF2D-4794-81E1-518FB15770D1",
"WebName": "Mallory Cortez",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "MalloryC@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "161476df-e508-4a29-b27e-09b61903b82b",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": null,
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "161476DF-E508-4A29-B27E-09B61903B82B",
"WebName": "Cameron White",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "CameronW@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "22a79328-9325-4bb8-b549-5731446a2a24",
"Status": "----",
"SipAddress": "sip:jonis@m365x33712745.onmicrosoft.com",
"LineURI": null,
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "22A79328-9325-4BB8-B549-5731446A2A24",
"WebName": "Joni Sherman",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "JoniS@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "23727739-a224-4a23-a2c0-f4c4d9453875",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": null,
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "23727739-A224-4A23-A2C0-F4C4D9453875",
"WebName": "Automate Bot",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "AutomateB@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "285f91c7-7ff4-4886-a80b-96eb417f28de",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": null,
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "285F91C7-7FF4-4886-A80B-96EB417F28DE",
"WebName": "Microsoft Service Account",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "ms-serviceaccount@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "47aaa67d-453f-4ce0-a903-19f7f5e08e1c",
"Status": "----",
"SipAddress": "sip:diegos@m365x33712745.onmicrosoft.com",
"LineURI": null,
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "47AAA67D-453F-4CE0-A903-19F7F5E08E1C",
"WebName": "Diego Siciliani",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "DiegoS@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "47d18bc6-4919-4ab7-9661-5f1be0630155",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "47D18BC6-4919-4AB7-9661-5F1BE0630155",
"WebName": "Allan Deyoung",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "AllanD@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "49243d55-bc4a-4cfb-9ad9-f67d28cac57b",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": null,
"HybridPstnSiteName": null,
"UsageLocation": null,
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "49243D55-BC4A-4CFB-9AD9-F67D28CAC57B",
"WebName": "Brian Johnson (TAILSPIN)",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "BrianJ@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "4adcbb3b-a156-4705-a5a5-33ba1f0c66a8",
"Status": "----",
"SipAddress": null,
"LineURI": null,
"HostingProvider": null,
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "4ADCBB3B-A156-4705-A5A5-33BA1F0C66A8",
"WebName": "Bianca Pisani",
"UserType": "NoService",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "7e24d47c-eb72-439a-84e4-aea1bdb1eed9",
"UserPrincipalName": "BiancaP@M365x33712745.OnMicrosoft.com",
"MsInterpretedUserType": "PureOnlineUserWithNoService",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
}
]
}Response
| ■ | 200 OK |
|
Parameter |
Type |
Description |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Index summary data |
integer |
|
||||||||||||
|
Identity |
string($uuid) (path) |
Live Platform generated customer Guid. |
||||||||||||
|
Status |
- |
- |
||||||||||||
|
SipAddress |
|
Email address of the SIP user, for example, sip:meganb@m365x33712745.onmicrosoft.com |
||||||||||||
|
CallForward |
|
Indicates whether Call Forwarding is enabled for the user. |
||||||||||||
|
Department |
string |
Active Directory User department. |
||||||||||||
|
WebName |
string |
Name of the M365 customer tenant user. |
||||||||||||
|
SipAddress |
string |
M365 user SIP address. For example, sip:adelev@m365x21689653.onmicrosoft.com |
||||||||||||
|
LineURI |
string |
Line URI assigned to user. |
||||||||||||
|
HostingProvider |
string |
sipfed.online.lync.com |
||||||||||||
|
HybridPstnSiteName |
string |
Name of the site location |
||||||||||||
|
UsageLocation |
string |
Usage Location as defined in the customer tenant Microsoft Entra admin center (see Set Usage Location). |
||||||||||||
|
RegistrarPool |
string |
- | ||||||||||||
|
CallForward |
string |
|
||||||||||||
|
ObjectId |
string |
- | ||||||||||||
|
WebName |
string |
For example, Megan Bowen |
||||||||||||
|
PsCount |
integer |
- | ||||||||||||
|
IsManaged |
boolean |
- | ||||||||||||
|
Department |
string |
Indicates the name of the Microsoft Azure Active Directory department object. |
||||||||||||
|
OnlineVoiceRoutingPolicy |
string |
Default: unrestricted or SiteLocationTag-Unrestricted |
||||||||||||
|
TenantId |
string |
Microsoft Azure subscription Tenant ID of the customer attached to the service. |
||||||||||||
|
MsInterpretedUserType |
string |
PureOnlineTeamsOnlyUser |
||||||||||||
|
UserPrincipalName |
string |
UPN, for example, MeganB@M365x33712745.OnMicrosoft.com |
||||||||||||
|
EnterpriseVoiceEnabled |
boolean |
Indicates whether Enterprise Voice is enabled. |
||||||||||||
|
OnlineVoiceRoutingPolicy |
string |
Name of the OnlineVoiceRoutingPolicy applied to user through LifeCycle Management templates (Direct Routing only). |
||||||||||||
|
OnlinePstnGateway |
string |
Name of the OnlinePSTNGateway of the Service Provider or Customer sub domain for connecting calls between Microsoft Teams and Calling trunk. |
| ■ | 400 Bad Request |
| ■ | 500 Internal Server Error |